Add Note Transactions
vFire has two Application Programming Interfaces (or APIs), which enable you to develop programs that automate many common vFire transactions. This section of the documentation deals with the Classic API. For more information on the RESTful Alemba API, introduced in 9.7, see here.
Add Note transactions are used to add notes to calls, requests and tasks.
AddNote Transaction
The AddNote transaction can be used to add a note to an existing call, request or task. In this transaction, the entity type to which to add the note is specified as an enumerated value.
Input Parameters: AddNoteRequest
Argument |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
sID |
String |
No. See Transaction Login. |
“” |
Analyst’s current Session ID |
sLoginUserID |
String |
No. See Transaction Login. |
“” |
Analyst’s Login ID |
sLoginPassword |
String |
No. See Transaction Login. |
“” |
Analyst’s Password |
sDatabase |
String |
No. See Transaction Login. |
“” |
Name of the vFire system for logging in. |
lEntityRef |
Lookup Field |
Yes |
- |
Call / Request / Task number to which the note is added. |
eEntityType |
Enumerated |
Yes This is mandatory in vFire, despite the third party documentation suggesting that it can be optional in some cases. |
- |
Entity to which to add a note. Values:
|
bIsHTML |
Boolean |
No |
False |
Format in which Note Text will be added. Values:
|
sNoteText |
String |
No |
“” |
Note contents to be added to the call / request / task. |
bEmail |
Boolean |
No |
False |
Send an email to the currently assigned analyst/group regarding this note. Values:
|
bEmailForum |
Boolean |
No |
False |
Only applies to notes added to Calls. Send an email to forum members on the call about this note. Values:
|
bInternal |
Boolean |
No |
False |
Send an internal message to the currently assigned analyst/group regarding this note. Values:
|
bPager |
Boolean |
No |
False |
Send a pager message to the currently assigned analyst/group regarding this note. Values:
|
yPortal |
Yes/No |
No |
No |
Publish this note on Self Service Portal? Values:
|
lSecurityProfile |
Lookup Field |
No |
0 |
Security Profile to apply to the note |
sReason |
String |
No |
“” |
Audit reason. If Change Reasons are mandatory, this field is mandatory. |
aCustomParameters |
Array |
No |
“” |
Return Values: AddNoteResponse
Argument |
Type |
Description |
---|---|---|
nEntityRef |
Integer |
Call / Request / Task number to which the note was added |
String |
Error/Warning Message returned from the API Transaction |
|
Ret |
Error/Warning Message returned from the API Transaction |